| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

BitStream.h
1 // BitStream.h
3 //
5
6 namespace nkMemory
7 {
11 class BitStream
12 {
13 public :
14
15 // Constructor, destructor
21 BitStream (BufferView<> data) noexcept ;
22
23 // Getters
27 BufferView<> getData () const ;
31 unsigned char getCurrentByte () const ;
35 unsigned int getByteCounter () const ;
41 unsigned int getBitCounter () const ;
47 bool isAtEos () const ;
48
49 // Controls
59 unsigned int peekMsb (unsigned int count) ;
69 unsigned int peekLsb (unsigned int count) ;
76 unsigned int readMsb (unsigned int count) ;
83 unsigned int readLsb (unsigned int count) ;
89 void moveForward (unsigned int count) ;
94 void moveToNextByte () ;
101 void moveTo (unsigned int byteCount, unsigned int bitCount) ;
105 void rewind () ;
106 } ;
107 }
nkMemory::BitStream::isAtEos
bool isAtEos() const
nkMemory::BitStream::moveToNextByte
void moveToNextByte()
nkMemory::BitStream
Offers capabilities to read data bit per bit.
Definition: BitStream.h:12
nkMemory::BitStream::BitStream
BitStream(BufferView<> data) noexcept
nkMemory::BitStream::readMsb
unsigned int readMsb(unsigned int count)
nkMemory::BufferView
A view over data.
Definition: BufferView.h:18
nkMemory::BitStream::rewind
void rewind()
nkMemory::BitStream::getCurrentByte
unsigned char getCurrentByte() const
nkMemory::BitStream::getBitCounter
unsigned int getBitCounter() const
nkMemory::BitStream::peekMsb
unsigned int peekMsb(unsigned int count)
nkMemory::BitStream::getByteCounter
unsigned int getByteCounter() const
nkMemory::BitStream::peekLsb
unsigned int peekLsb(unsigned int count)
nkMemory::BitStream::getData
BufferView getData() const
nkMemory::BitStream::readLsb
unsigned int readLsb(unsigned int count)
nkMemory::BitStream::moveTo
void moveTo(unsigned int byteCount, unsigned int bitCount)
nkMemory::BitStream::moveForward
void moveForward(unsigned int count)
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7